feat: add a utility to collate readmes from multiple versions.#329
feat: add a utility to collate readmes from multiple versions.#329
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
| @@ -0,0 +1,17 @@ | |||
| ### kernels collate-readme | |||
|
|
|||
| Use `kernels collate-readme <repo_id>` to generate a README for the `main` | |||
There was a problem hiding this comment.
Repo READMEs are instantiated cards. Shouldn't the versions be enumerated by card filling?
There was a problem hiding this comment.
Sorry didn't get it. Did you mean #287 should have a section on "Versions" in the card template and populate it automatically?
Even if that's the case, I think the PR could still have its own scope because we're tackling the README that will be included in the main revision of the kernel repo. The builder will automatically generate the cards and push to particular revisions in which case the README will still likely stay blank. Or am I missing something?
There was a problem hiding this comment.
For now I think main will be the default branch that is shown? Then main's README should be the instantiated card of the most recent version. I am not sure if all the version branches need individual cards, since we do not want people to actually use older versions. We leave them around to avoid breakage for people who haven't updated their code to use the latest kernel version yet, other than that, we should hide the old versions as much as possible.
|
Ah this makes sense. Let me push some changes and get it ready! I think we should make the version policies a bit more visible on our docs. Potentially, also warn users if newer versions are available and if they using older ones? |
Yeah, a warn-level log would be awesome! |
4 participants
Fixes #315
I am guessing we should incorporate this utility within the builder (perhaps the build and upload command) or something?